Deal Usage API
Response Attributes
/deals
Method: GET
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | pagination.total | Number | "total": 144 | Number of records matched based on the input | |
| 2 | pagination.max | Number | "max": 100 | Results fetched based on the input page size | |
| 3 | pagination.offset | Number | "offset": 1 | Index of the starting record in the response based on the value in request payload | |
| 4 | pagination.prev | String | "prev": null | Prev page link. | |
| 5 | pagination.next | String | "next": null | Next page link. | |
| 6 | items.dealId | String | "dealId":"12345" | DealId | |
| 7 | items.dealName | String | "dealName": "TEST DEAL" | Name of the deal | |
| 8 | items.dealStatus | String | "dealStatus": "Approved" | Deal Status | |
| 9 | items.dealApprovalDate | String | "dealApprovalDate": "28-Oct-2024" | Deal Approved Date | |
| 10 | items.priceProtectionExpiryDate | String | "priceProtectionExpiryDate": "28-Oct-2024" | Price protection expiry date | |
| 11 | items.dealExpirationDate | String | "dealExpirationDate": "28-Oct-2024" | Deal Expiration date | |
| 12 | items.quoteId | String | "quoteId": "12344" | QuoteId | |
| 13 | items.quoteName | String | "quoteName": "TEST" | Name of the Quote | |
| 14 | items.quoteStatus | String | "quoteStatus": "Approved" | Status of the quote | |
| 15 | items.quoteExpirationDate | String | "quoteExpirationDate": "28-Oct-2024" | Quote Expiration Date | |
| 16 | items.tryAndBuy | String | "tryAndBuy": "NO" | Try and Buy |
/deals/{dealid}/details
Method: GET
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | pagination.total | Number | "total": 16 | Number of records matched based on the input | |
| 2 | pagination.max | Number | "max": 2 | Results fetched based on the input page size | |
| 3 | pagination.offset | Number | "offset": 1 | Index of the starting record in the response based on the value in request payload | |
| 4 | pagination.prev | String | "prev": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/57272668/details?offset=0&max=2" | Prev page link. | |
| 5 | pagination.next | String | "next": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/57272668/details?offset=3&max=2" | Next page link. | |
| 6 | dealHeader.dealId | String | "dealId":"12345" | DealId | |
| 7 | dealHeader.dealName | String | "dealName": "TEST DEAL" | Name of the deal | |
| 8 | dealHeader.dealStatus | String | "dealStatus": "Approved" | Deal Status | |
| 9 | dealHeader.dealApprovalDate | String | "dealApprovalDate": "28-Oct-2024" | Deal Approved Date | |
| 10 | dealHeader.priceProtectionExpiryDate | String | "priceProtectionExpiryDate": "28-Oct-2024" | Price protection expiry date | |
| 11 | dealHeader.dealExpirationDate | String | "dealExpirationDate": "28-Oct-2024" | Deal Expiration date | |
| 12 | dealHeader.quoteId | String | "quoteId": "12344" | QuoteId | |
| 13 | dealHeader.quoteName | String | "quoteName": "TEST" | Name of the Quote | |
| 14 | dealHeader.quoteStatus | String | "quoteStatus": "Approved" | Status of the quote | |
| 15 | dealHeader.quoteExpirationDate | String | "quoteExpirationDate": "28-Oct-2024" | Quote Expiration Date | |
| 16 | dealHeader.tryAndBuy | String | "tryAndBuy": "NO" | Try and Buy | |
| 17 | dealDetailLines.items.magicKey | String | "magicKey":"QWOII8" | magicKey | |
| 18 | dealDetailLines.items.productId | String | "productId": "PID-XYZ-1000" | productId | |
| 19 | dealDetailLines.items.dealQuantity | Number | "dealQuantity": 12 | dealQuantity | |
| 20 | dealDetailLines.items.bookingConsumedQuantity | Number | "bookingConsumedQuantity": 50 | bookingConsumedQuantity | |
| 21 | dealDetailLines.items.bookingAvailableQuantity | Number | "bookingAvailableQuantity": 50 | bookingAvailableQuantity | |
| 22 | dealDetailLines.items.ciscoOrderBookedQuantity | Number | "ciscoOrderBookedQuantity": 10 | ciscoOrderBookedQuantity | |
| 23 | dealDetailLines.items.distiPosConsumedQuantity | Number | "distiPosConsumedQuantity": 10 | distiPosConsumedQuantity | |
| 24 | dealDetailLines.items.ciscoOrderInvoicedQuantity | Number | "ciscoOrderInvoicedQuantity": 20 | ciscoOrderInvoicedQuantity | |
| 25 | dealDetailLines.items.claimConsumedQuantity | Number | "claimConsumedQuantity": 20 | claimConsumedQuantity | |
| 26 | dealDetailLines.items.claimAvailableQuantity | Number | "claimAvailableQuantity":20 | claimAvailableQuantity | |
| 27 | dealDetailLines.items.dealExtendedNetPrice | Double | "dealExtendedNetPrice": 1233.90 | dealExtendedNetPrice | |
| 28 | dealDetailLines.items.ciscoSoNumber | String | "ciscoSoNumber": "S9090900" | ciscoSoNumber | |
| 29 | dealDetailLines.items.sourceName | String | sourceName": "TEST" | sourceName |
/deals/{dealid}/transaction-lines
Method: GET
lineType: dsv
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | pagination.total | Number | "total": 17 | Number of records matched based on the input | |
| 2 | pagination.max | Number | "max": 10 | Results fetched based on the input page size | |
| 3 | pagination.offset | Number | "offset": 1 | Index of the starting record in the response based on the value in request payload | |
| 4 | pagination.prev | String | "prev": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/57272668/transaction-lines?offset=0&max=10&lineType=dsv" | Prev page link. | |
| 5 | pagination.next | String | "next": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/57272668/transaction-lines?offset=11&max=10&lineType=dsv" | Next page link. | |
| 6 | dealHeader.dealId | String | "dealId":"12345" | DealId | |
| 7 | dealHeader.dealName | String | "dealName": "TEST DEAL" | Name of the deal | |
| 8 | dealHeader.dealStatus | String | "dealStatus": "Approved" | Deal Status | |
| 9 | dealHeader.dealApprovalDate | String | "dealApprovalDate": "28-Oct-2024" | Deal Approved Date | |
| 10 | dealHeader.priceProtectionExpiryDate | String | "priceProtectionExpiryDate": "28-Oct-2024" | Price protection expiry date | |
| 11 | dealHeader.dealExpirationDate | String | "dealExpirationDate": "28-Oct-2024" | Deal Expiration date | |
| 12 | dealHeader.quoteId | String | "quoteId": "12344" | QuoteId | |
| 13 | dealHeader.quoteName | String | "quoteName": "TEST" | Name of the Quote | |
| 14 | dealHeader.quoteStatus | String | "quoteStatus": "Approved" | Status of the quote | |
| 15 | dealHeader.quoteExpirationDate | String | "quoteExpirationDate": "28-Oct-2024" | Quote Expiration Date | |
| 16 | dealHeader.tryAndBuy | String | "tryAndBuy": "NO" | Try and Buy | |
| 17 | dsvLines.submissionId | Number | "submissionId":12345 | submissionId | |
| 18 | dsvLines.batchId | Number | "batchId": 1234 | batchId | |
| 19 | dsvLines.transId | Number | "transId": 1234 | transId | |
| 20 | dsvLines.dealId | String | "dealId": "28-Oct-2024" | dealId | |
| 21 | dsvLines.magicKey | String | "magicKey": "QII900" | magicKey | |
| 22 | dsvLines.salesOrderNumber | String | "salesOrderNumber": "1234" | salesOrderNumber | |
| 23 | dsvLines.salesOrderLineNumber | String | "salesOrderLineNumber": "1212" | salesOrderLineNumber | |
| 24 | dsvLines.dsvUniqueId | Number | "dsvUniqueId": 224 | dsvUniqueId | |
| 25 | dsvLines.partNumber | String | "partNumber": "hk899" | partNumber | |
| 26 | dsvLines.quantity | Number | "quantity": 12 | quantity | |
| 27 | dsvLines.dsvStatus | String | "dsvStatus": "CLOSED" | dsvStatus | |
| 28 | dsvLines.ciscoBookDate | String | "ciscoBookDate": "28-Oct-2024" | ciscoBookDate | |
| 29 | dsvLines.unitPrice | Double | "unitPrice":"12 | unitPrice | |
| 30 | dsvLines.netPrice | Double | "netPrice": 12 | netPrice | |
| 31 | dsvLines.resellerName | String | "resellerName": "TECKY" | resellerName | |
| 32 | dsvLines.endUserName | String | "endUserName": "SICKIU" | endUserName | |
| 33 | dsvLines.sourceName | String | "sourceName": "SOUTHWALES" | sourceName |
lineType: pos
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | pagination.total | Number | "total": 2 | Number of records matched based on the input | |
| 2 | pagination.max | Number | "max": 10 | Results fetched based on the input page size | |
| 3 | pagination.offset | Number | "offset": 1 | Index of the starting record in the response based on the value in request payload | |
| 4 | pagination.prev | String | "prev": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/57272668/transaction-lines?offset=0&max=10&lineType=pos" | Prev page link. | |
| 5 | pagination.next | String | "next": null | Next page link. | |
| 6 | dealHeader.dealId | String | "dealId":"12345" | DealId | |
| 7 | dealHeader.dealName | String | "dealName": "TEST DEAL" | Name of the deal | |
| 8 | dealHeader.dealStatus | String | "dealStatus": "Approved" | Deal Status | |
| 9 | dealHeader.dealApprovalDate | String | "dealApprovalDate": "28-Oct-2024" | Deal Approved Date | |
| 10 | dealHeader.priceProtectionExpiryDate | String | "priceProtectionExpiryDate": "28-Oct-2024" | Price protection expiry date | |
| 11 | dealHeader.dealExpirationDate | String | "dealExpirationDate": "28-Oct-2024" | Deal Expiration date | |
| 12 | dealHeader.quoteId | String | "quoteId": "12344" | QuoteId | |
| 13 | dealHeader.quoteName | String | "quoteName": "TEST" | Name of the Quote | |
| 14 | dealHeader.quoteStatus | String | "quoteStatus": "Approved" | Status of the quote | |
| 15 | dealHeader.quoteExpirationDate | String | "quoteExpirationDate": "28-Oct-2024" | Quote Expiration Date | |
| 16 | dealHeader.tryAndBuy | String | "tryAndBuy": "NO" | Try and Buy | |
| 17 | posLines.posTransId | Number | "posTransId":12345 | DealId | |
| 18 | posLines.dealId | String | "dealId":1234 | Name of the deal | |
| 19 | posLines.distiToResellerInvoiceNumber | String | "distiToResellerInvoiceNumber": "394858" | distiToResellerInvoiceNumber | |
| 20 | posLines.distiToResellerInvoiceDate | String | "distiToResellerInvoiceDate": "27-APR-2025" | distiToResellerInvoiceDate | |
| 21 | posLines.magicKey | String | "magicKey": "Q233993K" | magicKey | |
| 22 | posLines.salesOrderNumber | String | "salesOrderNumber": "2022" | salesOrderNumber | |
| 23 | posLines.salesOrderLineNumber | String | "salesOrderLineNumber":"12344" | salesOrderLineNumber | |
| 24 | posLines.dsvUniqueId | String | "dsvUniqueId": 223 | dsvUniqueId | |
| 25 | posLines.partNumber | String | "partNumber": "SS45" | partNumber | |
| 26 | posLines.quantity | Number | "quantity": 1 | quantity | |
| 27 | posLines.status | String | "status": "VALID" | status | |
| 28 | posLines.unitPrice | Double | "unitPrice":23.98 | unitPrice | |
| 29 | posLines.netPrice | Double | "netPrice": "20.34 | netPrice | |
| 30 | posLines.resellerName | String | " resellerName": "201 SUSSEX STREET" | resellerName | |
| 31 | posLines.endUserName | String | "endUserName": "SYDNEY" | endUserName | |
| 32 | posLines.sourceName | String | "sourceName": "SOUTHWALES" | sourceName |
lineType: cisco-order
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | pagination.total | Number | "total": 16 | Number of records matched based on the input | |
| 2 | pagination.max | Number | "max": 10 | Results fetched based on the input page size | |
| 3 | pagination.offset | Number | "offset": 2 | Index of the starting record in the response based on the value in request payload | |
| 4 | pagination.prev | String | "prev": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/57272668/transaction-lines?offset=0&max=10&lineType=cisco-order" | Prev page link. | |
| 5 | pagination.next | String | "next": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/57272668/transaction-lines?offset=12&max=10&lineType=cisco-order" | Next page link. | |
| 6 | dealHeader.dealId | String | "dealId":"12345" | DealId | |
| 7 | dealHeader.dealName | String | "dealName": "TEST DEAL" | Name of the deal | |
| 8 | dealHeader.dealStatus | String | "dealStatus": "Approved" | Deal Status | |
| 9 | dealHeader.dealApprovalDate | String | "dealApprovalDate": "28-Oct-2024" | Deal Approved Date | |
| 10 | dealHeader.priceProtectionExpiryDate | String | "priceProtectionExpiryDate": "28-Oct-2024" | Price protection expiry date | |
| 11 | dealHeader.dealExpirationDate | String | "dealExpirationDate": "28-Oct-2024" | Deal Expiration date | |
| 12 | dealHeader.quoteId | String | "quoteId": "12344" | QuoteId | |
| 13 | dealHeader.quoteName | String | "quoteName": "TEST" | Name of the Quote | |
| 14 | dealHeader.quoteStatus | String | "quoteStatus": "Approved" | Status of the quote | |
| 15 | dealHeader.quoteExpirationDate | String | "quoteExpirationDate": "28-Oct-2024" | Quote Expiration Date | |
| 16 | dealHeader.tryAndBuy | String | "tryAndBuy": "NO" | Try and Buy | |
| 17 | ciscoOrderLines.dealId | String | "dealId": "TEST DEAL" | Name of the deal | |
| 18 | ciscoOrderLines.orderNumber | String | "orderNumber": "1234" | orderNumber | |
| 19 | ciscoOrderLines.orderLineId | String | "orderLineId": "998999" | orderLineId | |
| 20 | ciscoOrderLines.magicKey | String | "magicKey": "QWW3733UU" | magicKey | |
| 21 | ciscoOrderLines.productId | String | "productId": "MR-099" | productId | |
| 22 | ciscoOrderLines.quantity | Number | "quantity": 23 | quantity | |
| 23 | ciscoOrderLines.netUnitPrice | Double | "netUnitPrice": 360.55 | netUnitPrice | |
| 24 | ciscoOrderLines.extendedNetUnitPrice | Double | "extendedNetUnitPrice": 1212.78 | extendedNetUnitPrice | |
| 25 | ciscoOrderLines.resellerName | String | "resellerName": "201 SUSSEX STREET" | resellerName | |
| 26 | ciscoOrderLines.endUserName | String | "endUserName": "SYDNEY" | endUserName | |
| 27 | ciscoOrderLines.sourceName | String | "sourceName": "SOUTHWALES" | sourceName |
lineType: claim
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | pagination.total | Number | "total": 800 | Number of records matched based on the input | |
| 2 | pagination.max | Number | "max": 10 | Results fetched based on the input page size | |
| 3 | pagination.offset | Number | "offset": 2 | Index of the starting record in the response based on the value in request payload | |
| 4 | pagination.prev | String | "prev": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/69886148/transaction-lines?offset=0&max=10&lineType=claim" | Prev page link. | |
| 5 | pagination.next | String | "next": "https://apx-test.cisco.com/dfm/services/api/v1/dealusage/deals/69886148/transaction-lines?offset=12&max=10&lineType=claim" | Next page link. | |
| 6 | dealHeader.dealId | String | "dealId":"12345" | DealId | |
| 7 | dealHeader.dealName | String | "dealName": "TEST DEAL" | Name of the deal | |
| 8 | dealHeader.dealStatus | String | "dealStatus": "Approved" | Deal Status | |
| 9 | dealHeader.dealApprovalDate | String | "dealApprovalDate": "28-Oct-2024" | Deal Approved Date | |
| 10 | dealHeader.priceProtectionExpiryDate | String | "priceProtectionExpiryDate": "28-Oct-2024" | Price protection expiry date | |
| 11 | dealHeader.dealExpirationDate | String | "dealExpirationDate": "28-Oct-2024" | Deal Expiration date | |
| 12 | dealHeader.quoteId | String | "quoteId": "12344" | QuoteId | |
| 13 | dealHeader.quoteName | String | "quoteName": "TEST" | Name of the Quote | |
| 14 | dealHeader.quoteStatus | String | "quoteStatus": "Approved" | Status of the quote | |
| 15 | dealHeader.quoteExpirationDate | String | "quoteExpirationDate": "28-Oct-2024" | Quote Expiration Date | |
| 16 | dealHeader.tryAndBuy | String | "tryAndBuy": "NO" | Try and Buy | |
| 17 | claimlLines.claimId | Number | "claimId": 1234 | claimId | |
| 18 | claimlLines.claimDetailId | Number | "claimDetailId": 88861276 | claimDetailId | |
| 19 | claimlLines.productId | String | "productId": "SD-UI8" | productId | |
| 20 | claimlLines.eligibleQuantity | Number | "eligibleQuantity": 12 | eligibleQuantity | |
| 21 | claimlLines.magicKey | String | "magicKey": "QWW29922" | magicKey | |
| 22 | claimlLines.claimStatus | String | "claimStatus": "VALID" | claimStatus | |
| 23 | claimlLines.claimReference | String | "claimReference": "TEST" | claimReference | |
| 24 | claimlLines.creditMemoNumber | String | "creditMemoNumber": "Approved" | creditMemoNumber | |
| 25 | claimlLines.rejectedReason | String | "rejectedReason": "Test" | rejectedReason | |
| 26 | claimlLines.eligibleUnitRebate | Double | "eligibleUnitRebate": 1233.12 | eligibleUnitRebate | |
| 27 | claimlLines.eligibleExtAmount | Double | "eligibleExtAmount": 121212.12 | eligibleExtAmount | |
| 28 | claimlLines.distributorSONumber | String | "distributorSONumber": "89u9898" | distributorSONumber | |
| 29 | claimlLines.distributorSOLineNo | String | "distributorSOLineNo": "1222" | distributorSOLineNo | |
| 30 | claimlLines.validationReason | String | "validationReason": "TEST" | validationReason | |
| 31 | claimlLines.sourceName | String | "sourceName": "SOUTHWALES" | sourceName |